CockroachDB Support#388
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds CockroachDB compatibility to the system database layer and refactors how SysDB data access and event delivery are implemented (including a new signal/subscription abstraction and a configurable LISTEN/NOTIFY vs polling mode).
Changes:
- Introduces
useListenNotifyconfiguration and CockroachDB detection to automatically disable LISTEN/NOTIFY where unsupported. - Refactors SysDB access into DAO classes using a shared
DbContext, and rewritesrecv/getEventaround a new signal infrastructure (SignalMap,SignalKey,Subscription). - Updates test infrastructure and CI to run against CockroachDB (container support, migrations expectations, and parallelism tuning).
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| transact/src/test/resources/junit-platform.properties | Switches JUnit parallel execution strategy to a custom strategy (for CRDB tuning). |
| transact/src/test/java/dev/dbos/transact/utils/PgContainer.java | Adds CRDB container support and changes test DB lifecycle to reuse + truncate instead of drop/recreate. |
| transact/src/test/java/dev/dbos/transact/utils/CrdbParallelExecutionConfigurationStrategy.java | Limits parallelism when running tests against CRDB. |
| transact/src/test/java/dev/dbos/transact/txstep/JdbcStepFactoryTest.java | Ensures required DB objects are present/clean when reusing pooled DBs. |
| transact/src/test/java/dev/dbos/transact/txstep/JdbcStepFactoryInitTest.java | Uses a fresh container and ensures database exists before running tests. |
| transact/src/test/java/dev/dbos/transact/migrations/MigrationManagerTest.java | Updates migration assertions for CRDB vs PG and adds coverage for notify-disabled migrations. |
| transact/src/test/java/dev/dbos/transact/migrations/CockroachMigrationTest.java | Adds explicit PG vs CRDB migration behavior tests (LISTEN/NOTIFY objects). |
| transact/src/test/java/dev/dbos/transact/invocation/CustomSchemaTest.java | Uses a fresh container for schema tests. |
| transact/src/test/java/dev/dbos/transact/execution/DBOSExecutorTest.java | Switches JDK gating from env vars to runtime feature checks. |
| transact/src/test/java/dev/dbos/transact/database/SignalMapTest.java | Adds tests for the new signal/subscription mechanism. |
| transact/src/test/java/dev/dbos/transact/database/ImportExportTest.java | Updates to new step result recording API. |
| transact/src/test/java/dev/dbos/transact/config/ConfigTest.java | Ensures DB existence for config tests that provide a prebuilt DataSource. |
| transact/src/test/java/dev/dbos/transact/client/PgSqlClientTest.java | Updates function invocation parameter ordering/signatures. |
| transact/src/main/java/dev/dbos/transact/workflow/internal/StepResult.java | Adds helpers to build step results from serialized output/error. |
| transact/src/main/java/dev/dbos/transact/migrations/MigrationManager.java | Adds CRDB-aware LISTEN/NOTIFY migration selection and moves migration-10 PK check into Java. |
| transact/src/main/java/dev/dbos/transact/execution/DBOSExecutor.java | Updates event/step APIs to new caller context and step result methods. |
| transact/src/main/java/dev/dbos/transact/DBOSClient.java | Adds a constructor parameter to control LISTEN/NOTIFY usage. |
| transact/src/main/java/dev/dbos/transact/database/SystemDatabase.java | Introduces DbContext, closed-checking, CRDB detection, and pluggable notification source. |
| transact/src/main/java/dev/dbos/transact/database/signal/Subscription.java | Adds an AutoCloseable subscription future type. |
| transact/src/main/java/dev/dbos/transact/database/signal/SignalMap.java | Adds a concurrent signal/subscribe map for wakeups. |
| transact/src/main/java/dev/dbos/transact/database/signal/SignalKey.java | Adds typed keys and wake reasons for signals. |
| transact/src/main/java/dev/dbos/transact/database/NotificationListenerSource.java | Replaces the prior notification service with a signal-map-based listener. |
| transact/src/main/java/dev/dbos/transact/database/GetWorkflowEventContext.java | Removes the old getEvent caller context record. |
| transact/src/main/java/dev/dbos/transact/database/GetEventCaller.java | Adds the new getEvent caller context record. |
| transact/src/main/java/dev/dbos/transact/database/DbContext.java | Adds a shared context object for DAOs (datasource/schema/serializer/closed check). |
| transact/src/main/java/dev/dbos/transact/database/dao/WorkflowDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/StreamsDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/StepsDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/SchedulesDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/QueuesDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/NotificationsDAO.java | Refactors recv/getEvent to new signal infra and DbContext + notification source abstractions. |
| transact/src/main/java/dev/dbos/transact/database/dao/ExternalStateDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/database/dao/ApplicationVersionDAO.java | Moves DAO into database/dao and refactors to accept DbContext. |
| transact/src/main/java/dev/dbos/transact/config/DBOSConfig.java | Adds useListenNotify to configuration and Spring/CLI integration points. |
| transact/build.gradle.kts | Adds test dependencies for JUnit platform engine and CockroachDB testcontainers. |
| transact-spring-boot-starter/src/test/java/dev/dbos/transact/spring/PgContainer.java | Updates testcontainer image tag. |
| transact-spring-boot-starter/src/main/java/dev/dbos/transact/spring/DBOSProperties.java | Adds Spring property useListenNotify. |
| transact-spring-boot-starter/src/main/java/dev/dbos/transact/spring/DBOSAutoConfiguration.java | Wires Spring property into DBOSConfig. |
| transact-jooq-step-factory/src/test/java/dev/dbos/transact/utils/PgContainer.java | Updates testcontainer image tag. |
| transact-jdbi-step-factory/src/test/java/dev/dbos/transact/utils/PgContainer.java | Updates testcontainer image tag. |
| transact-cli/src/test/java/dev/dbos/transact/cli/PgContainer.java | Updates testcontainer image tag. |
| transact-cli/src/main/java/dev/dbos/transact/cli/MigrateCommand.java | Updates migration invocation signature (adds useListenNotify parameter). |
| gradle/libs.versions.toml | Adds JUnit platform engine + CockroachDB testcontainers aliases. |
| .github/workflows/test_crdb.yml | Adds a dedicated CI workflow to run the suite against CockroachDB. |
| .github/workflows/on_push.yml | Runs the CRDB workflow on push. |
| .github/workflows/on_pr.yml | Runs the CRDB workflow on PRs. |
Comments suppressed due to low confidence (2)
transact/src/main/java/dev/dbos/transact/database/dao/NotificationsDAO.java:490
- When
getEventtimes out,result.value()isnulland the step result is recorded withoutput=null. On replay,StepResult.toResult()throws because both output and error are null, so a timed-outgetEventinside a workflow will not be replayable.
Record an explicit serialized null (e.g., SerializationUtil.serializeValue(null, ..., ctx.serializer())) so output is non-null, or adjust the replay logic to treat (output==null && error==null) as a recorded null result for this step type.
transact/src/test/java/dev/dbos/transact/utils/PgContainer.java:34
- Using floating
:latestimage tags makes the test environment non-reproducible and can introduce sudden breakages when upstream images change.
Pin these to known-good versions (for both PostgreSQL and CockroachDB) so CI and local runs are stable.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kraftp
reviewed
May 18, 2026
kraftp
reviewed
May 18, 2026
kraftp
approved these changes
May 18, 2026
This was referenced May 18, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds CockroachDB support. It also generally revamps how SysDB is organized and how Listen/Notify events are delivered.
Changes: